Updates the data catalog for a materialized model

Update the data catalog of the selected materialized model.

Method

/API3/dataSources/updateDataCatalog

  • API Section: /API3/dataSources
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Domain Admin

Method Signature

Input Parameters

Name

dataCatalogUpdateData

Object Type

DataCatalogUpdateData

Description

Data for data catalog update operation

Output Response

Successful Result Code

200

Response Type

ModifiedItemsResult

Description of Response Type

Generic API response object with success or failure flag and related messages.

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/dataSources/updateDataCatalog" \
 -d '{
  "materializedModelId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "dataCatalog" : {
    "dataCatalogItems" : [ {
      "uniqueName" : "uniqueName",
      "folder" : "folder",
      "displayName" : "displayName",
      "attributesTranslations" : [ {
        "language" : "language",
        "columnUniqueName" : "columnUniqueName"
      }, {
        "language" : "language",
        "columnUniqueName" : "columnUniqueName"
      } ],
      "description" : "description",
      "metadataTranslations" : [ {
        "name" : "name",
        "description" : "description",
        "language" : "language"
      }, {
        "name" : "name",
        "description" : "description",
        "language" : "language"
      } ],
      "type" : "type"
    }, {
      "uniqueName" : "uniqueName",
      "folder" : "folder",
      "displayName" : "displayName",
      "attributesTranslations" : [ {
        "language" : "language",
        "columnUniqueName" : "columnUniqueName"
      }, {
        "language" : "language",
        "columnUniqueName" : "columnUniqueName"
      } ],
      "description" : "description",
      "metadataTranslations" : [ {
        "name" : "name",
        "description" : "description",
        "language" : "language"
      }, {
        "name" : "name",
        "description" : "description",
        "language" : "language"
      } ],
      "type" : "type"
    } ]
  }
}'

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;

import java.util.*;
import java.time.*;

public class DataSourcesServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
        // Initialize the dataCatalogUpdateData parameter object for the call
        DataCatalogUpdateData dataCatalogUpdateData = ; // Create the input object for the operation, type: DataCatalogUpdateData 

        try {
            ModifiedItemsResult result = apiInstance.updateDataCatalog(dataCatalogUpdateData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourcesServiceApi#updateDataCatalog");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const dataCatalogUpdateData = ; // {DataCatalogUpdateData} 

api.updateDataCatalog(dataCatalogUpdateData).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class updateDataCatalogExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new DataSourcesServiceApi();
        // Initialize the dataCatalogUpdateData parameter object for the call
        var dataCatalogUpdateData = new DataCatalogUpdateData(); // DataCatalogUpdateData | 

        try {
            // Update the data catalog of the selected materialized model.
            ModifiedItemsResult result = apiInstance.updateDataCatalog(dataCatalogUpdateData);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling DataSourcesServiceApi.updateDataCatalog: " + e.Message );
        }
    }
}


import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = DataSourcesServiceApi(api_client)
    # Initialize the dataCatalogUpdateData parameter object for the call
    dataCatalogUpdateData =  # DataCatalogUpdateData | 

    try:
        # Update the data catalog of the selected materialized model.
        api_response = api_instance.update_data_catalog(dataCatalogUpdateData)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataSourcesServiceApi->updateDataCatalog: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
$dataCatalogUpdateData = ; // DataCatalogUpdateData | 

try {
    $result = $api_instance->updateDataCatalog($dataCatalogUpdateData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataSourcesServiceApi->updateDataCatalog: ', $e->getMessage(), PHP_EOL;
}
?>